2026/01/14 - Amazon Connect Service - 3 new9 updated api methods
Changes Amazon Connect makes it easier to manage contact center operating hours by enabling automated scheduling for recurring events like holidays and maintenance windows. Set up recurring patterns (weekly, monthly, etc.) or link to another hours of operation to inherit overrides.
Associates a set of hours of operations with another hours of operation. Refer to Administrator Guide here for more information on inheriting overrides from parent hours of operation(s).
See also: AWS API Documentation
Request Syntax
client.associate_hours_of_operations(
InstanceId='string',
HoursOfOperationId='string',
ParentHoursOfOperationConfigs=[
{
'HoursOfOperationId': 'string'
},
]
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the child hours of operation.
list
[REQUIRED]
The Amazon Resource Names (ARNs) of the parent hours of operation resources to associate with the child hours of operation resource.
(dict) --
Contains configuration for the parent hours of operation.
HoursOfOperationId (string) --
The identifier for the hours of operation.
None
Provides information about the child hours of operations for the specified parent hours of operation.
For more information about child hours of operations, see Link overrides from different hours of operation in the Administrator Guide.
See also: AWS API Documentation
Request Syntax
client.list_child_hours_of_operations(
InstanceId='string',
HoursOfOperationId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the parent hours of operation.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
integer
The maximum number of results to return per page. The default MaxResult size is 100.
dict
Response Syntax
{
'NextToken': 'string',
'ChildHoursOfOperationsSummaryList': [
{
'Name': 'string',
'Id': 'string',
'Arn': 'string'
},
],
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ChildHoursOfOperationsSummaryList (list) --
Information about the hours of operation.
(dict) --
Identifier for a hours of operations resource: ARN, ID, Name
Name (string) --
Name of the hours of operation
Id (string) --
Unique identifier of the hours of operation.
Arn (string) --
Amazon Resource Name (ARN) of the hours of operations.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
Disassociates a set of hours of operations with another hours of operation. Refer to Administrator Guide here for more information on inheriting overrides from parent hours of operation(s).
See also: AWS API Documentation
Request Syntax
client.disassociate_hours_of_operations(
InstanceId='string',
HoursOfOperationId='string',
ParentHoursOfOperationIds=[
'string',
]
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the child hours of operation.
list
[REQUIRED]
The Amazon Resource Names (ARNs) of the parent hours of operation resources to disassociate with the child hours of operation resource.
(string) --
None
{'ParentHoursOfOperationConfigs': [{'HoursOfOperationId': 'string'}]}
Creates hours of operation.
See also: AWS API Documentation
Request Syntax
client.create_hours_of_operation(
InstanceId='string',
Name='string',
Description='string',
TimeZone='string',
Config=[
{
'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'StartTime': {
'Hours': 123,
'Minutes': 123
},
'EndTime': {
'Hours': 123,
'Minutes': 123
}
},
],
ParentHoursOfOperationConfigs=[
{
'HoursOfOperationId': 'string'
},
],
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The name of the hours of operation.
string
The description of the hours of operation.
string
[REQUIRED]
The time zone of the hours of operation.
list
[REQUIRED]
Configuration information for the hours of operation: day, start time, and end time.
(dict) --
Contains information about the hours of operation.
Day (string) -- [REQUIRED]
The day that the hours of operation applies to.
StartTime (dict) -- [REQUIRED]
The start time that your contact center opens.
Hours (integer) -- [REQUIRED]
The hours.
Minutes (integer) -- [REQUIRED]
The minutes.
EndTime (dict) -- [REQUIRED]
The end time that your contact center closes.
Hours (integer) -- [REQUIRED]
The hours.
Minutes (integer) -- [REQUIRED]
The minutes.
list
Configuration for parent hours of operations. Eg: ResourceArn.
For more information about parent hours of operations, see Link overrides from different hours of operation in the Administrator Guide.
(dict) --
Contains configuration for the parent hours of operation.
HoursOfOperationId (string) --
The identifier for the hours of operation.
dict
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
dict
Response Syntax
{
'HoursOfOperationId': 'string',
'HoursOfOperationArn': 'string'
}
Response Structure
(dict) --
HoursOfOperationId (string) --
The identifier for the hours of operation.
HoursOfOperationArn (string) --
The Amazon Resource Name (ARN) for the hours of operation.
{'OverrideType': 'STANDARD | OPEN | CLOSED',
'RecurrenceConfig': {'RecurrencePattern': {'ByMonth': ['integer'],
'ByMonthDay': ['integer'],
'ByWeekdayOccurrence': ['integer'],
'Frequency': 'WEEKLY | MONTHLY | '
'YEARLY',
'Interval': 'integer'}}}
Creates an hours of operation override in an Amazon Connect hours of operation resource.
See also: AWS API Documentation
Request Syntax
client.create_hours_of_operation_override(
InstanceId='string',
HoursOfOperationId='string',
Name='string',
Description='string',
Config=[
{
'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'StartTime': {
'Hours': 123,
'Minutes': 123
},
'EndTime': {
'Hours': 123,
'Minutes': 123
}
},
],
EffectiveFrom='string',
EffectiveTill='string',
RecurrenceConfig={
'RecurrencePattern': {
'Frequency': 'WEEKLY'|'MONTHLY'|'YEARLY',
'Interval': 123,
'ByMonth': [
123,
],
'ByMonthDay': [
123,
],
'ByWeekdayOccurrence': [
123,
]
}
},
OverrideType='STANDARD'|'OPEN'|'CLOSED'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance.
string
[REQUIRED]
The identifier for the hours of operation
string
[REQUIRED]
The name of the hours of operation override.
string
The description of the hours of operation override.
list
[REQUIRED]
Configuration information for the hours of operation override: day, start time, and end time.
(dict) --
Information about the hours of operation override config: day, start time, and end time.
Day (string) --
The day that the hours of operation override applies to.
StartTime (dict) --
The start time when your contact center opens if overrides are applied.
Hours (integer) -- [REQUIRED]
The hours.
Minutes (integer) -- [REQUIRED]
The minutes.
EndTime (dict) --
The end time that your contact center closes if overrides are applied.
Hours (integer) -- [REQUIRED]
The hours.
Minutes (integer) -- [REQUIRED]
The minutes.
string
[REQUIRED]
The date from when the hours of operation override is effective.
string
[REQUIRED]
The date until when the hours of operation override is effective.
dict
Configuration for a recurring event.
RecurrencePattern (dict) -- [REQUIRED]
The recurrence pattern that defines how the event repeats. Example: Frequency, Interval, ByMonth, ByMonthDay, ByWeekdayOccurrence
Frequency (string) -- [REQUIRED]
Defines how often the pattern repeats. This is the base unit for the recurrence schedule and works in conjunction with the Interval field to determine the exact repetition sequence.
Interval (integer) -- [REQUIRED]
Specifies the number of frequency units between each occurrence. Must be a positive integer.
Examples: To repeat every week, set Interval=1 with WEEKLY frequency. To repeat every two months, set Interval=2 with MONTHLY frequency.
ByMonth (list) --
Specifies which month the event should occur in (1-12, where 1=January, 12=December). Used with YEARLY frequency to schedule events in specific month.
Note: It does not accept multiple values in the same list
(integer) --
ByMonthDay (list) --
Specifies which day of the month the event should occur on (1-31). Used with MONTHLY or YEARLY frequency to schedule events on specific date within a month.
Examples: [15] for events on the 15th of each month, [-1] for events on the last day of month.
Note: It does not accept multiple values in the same list. If a specified day doesn't exist in a particular month (e.g., day 31 in February), the event will be skipped for that month. This field cannot be used simultaneously with ByWeekdayOccurrence as they represent different scheduling approaches (specific dates vs. relative weekday positions).
(integer) --
ByWeekdayOccurrence (list) --
Specifies which occurrence of a weekday within the month the event should occur on. Must be used with MONTHLY or YEARLY frequency.
Example: 2 corresponds to second occurrence of the weekday in the month. -1 corresponds to last occurrence of the weekday in the month
The weekday itself is specified separately in the HoursOfOperationConfig. Example: To schedule the recurring event for the 2nd Thursday of April every year, set ByWeekdayOccurrence=[2], Day=THURSDAY, ByMonth=[4], Frequency: YEARLY and INTERVAL=1.
(integer) --
string
Whether the override will be defined as a standard or as a recurring event.
For more information about how override types are applied, see Build your list of overrides in the Administrator Guide.
dict
Response Syntax
{
'HoursOfOperationOverrideId': 'string'
}
Response Structure
(dict) --
HoursOfOperationOverrideId (string) --
The identifier for the hours of operation override.
{'HoursOfOperation': {'ParentHoursOfOperations': [{'Arn': 'string',
'Id': 'string',
'Name': 'string'}]}}
Describes the hours of operation.
See also: AWS API Documentation
Request Syntax
client.describe_hours_of_operation(
InstanceId='string',
HoursOfOperationId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier for the hours of operation.
dict
Response Syntax
{
'HoursOfOperation': {
'HoursOfOperationId': 'string',
'HoursOfOperationArn': 'string',
'Name': 'string',
'Description': 'string',
'TimeZone': 'string',
'Config': [
{
'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'StartTime': {
'Hours': 123,
'Minutes': 123
},
'EndTime': {
'Hours': 123,
'Minutes': 123
}
},
],
'ParentHoursOfOperations': [
{
'Name': 'string',
'Id': 'string',
'Arn': 'string'
},
],
'Tags': {
'string': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
}
Response Structure
(dict) --
HoursOfOperation (dict) --
The hours of operation.
HoursOfOperationId (string) --
The identifier for the hours of operation.
HoursOfOperationArn (string) --
The Amazon Resource Name (ARN) for the hours of operation.
Name (string) --
The name for the hours of operation.
Description (string) --
The description for the hours of operation.
TimeZone (string) --
The time zone for the hours of operation.
Config (list) --
Configuration information for the hours of operation.
(dict) --
Contains information about the hours of operation.
Day (string) --
The day that the hours of operation applies to.
StartTime (dict) --
The start time that your contact center opens.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
EndTime (dict) --
The end time that your contact center closes.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
ParentHoursOfOperations (list) --
Information about parent hours of operations.
(dict) --
Identifier for a hours of operations resource: ARN, ID, Name
Name (string) --
Name of the hours of operation
Id (string) --
Unique identifier of the hours of operation.
Arn (string) --
Amazon Resource Name (ARN) of the hours of operations.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'HoursOfOperationOverride': {'OverrideType': 'STANDARD | OPEN | CLOSED',
'RecurrenceConfig': {'RecurrencePattern': {'ByMonth': ['integer'],
'ByMonthDay': ['integer'],
'ByWeekdayOccurrence': ['integer'],
'Frequency': 'WEEKLY '
'| '
'MONTHLY '
'| '
'YEARLY',
'Interval': 'integer'}}}}
Describes the hours of operation override.
See also: AWS API Documentation
Request Syntax
client.describe_hours_of_operation_override(
InstanceId='string',
HoursOfOperationId='string',
HoursOfOperationOverrideId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance.
string
[REQUIRED]
The identifier for the hours of operation.
string
[REQUIRED]
The identifier for the hours of operation override.
dict
Response Syntax
{
'HoursOfOperationOverride': {
'HoursOfOperationOverrideId': 'string',
'HoursOfOperationId': 'string',
'HoursOfOperationArn': 'string',
'Name': 'string',
'Description': 'string',
'Config': [
{
'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'StartTime': {
'Hours': 123,
'Minutes': 123
},
'EndTime': {
'Hours': 123,
'Minutes': 123
}
},
],
'EffectiveFrom': 'string',
'EffectiveTill': 'string',
'RecurrenceConfig': {
'RecurrencePattern': {
'Frequency': 'WEEKLY'|'MONTHLY'|'YEARLY',
'Interval': 123,
'ByMonth': [
123,
],
'ByMonthDay': [
123,
],
'ByWeekdayOccurrence': [
123,
]
}
},
'OverrideType': 'STANDARD'|'OPEN'|'CLOSED'
}
}
Response Structure
(dict) --
HoursOfOperationOverride (dict) --
Information about the hours of operations override.
HoursOfOperationOverrideId (string) --
The identifier for the hours of operation override.
HoursOfOperationId (string) --
The identifier for the hours of operation.
HoursOfOperationArn (string) --
The Amazon Resource Name (ARN) for the hours of operation.
Name (string) --
The name of the hours of operation override.
Description (string) --
The description of the hours of operation override.
Config (list) --
Configuration information for the hours of operation override: day, start time, and end time.
(dict) --
Information about the hours of operation override config: day, start time, and end time.
Day (string) --
The day that the hours of operation override applies to.
StartTime (dict) --
The start time when your contact center opens if overrides are applied.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
EndTime (dict) --
The end time that your contact center closes if overrides are applied.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
EffectiveFrom (string) --
The date from which the hours of operation override would be effective.
EffectiveTill (string) --
The date until the hours of operation override is effective.
RecurrenceConfig (dict) --
Configuration for a recurring event.
RecurrencePattern (dict) --
The recurrence pattern that defines how the event repeats. Example: Frequency, Interval, ByMonth, ByMonthDay, ByWeekdayOccurrence
Frequency (string) --
Defines how often the pattern repeats. This is the base unit for the recurrence schedule and works in conjunction with the Interval field to determine the exact repetition sequence.
Interval (integer) --
Specifies the number of frequency units between each occurrence. Must be a positive integer.
Examples: To repeat every week, set Interval=1 with WEEKLY frequency. To repeat every two months, set Interval=2 with MONTHLY frequency.
ByMonth (list) --
Specifies which month the event should occur in (1-12, where 1=January, 12=December). Used with YEARLY frequency to schedule events in specific month.
Note: It does not accept multiple values in the same list
(integer) --
ByMonthDay (list) --
Specifies which day of the month the event should occur on (1-31). Used with MONTHLY or YEARLY frequency to schedule events on specific date within a month.
Examples: [15] for events on the 15th of each month, [-1] for events on the last day of month.
Note: It does not accept multiple values in the same list. If a specified day doesn't exist in a particular month (e.g., day 31 in February), the event will be skipped for that month. This field cannot be used simultaneously with ByWeekdayOccurrence as they represent different scheduling approaches (specific dates vs. relative weekday positions).
(integer) --
ByWeekdayOccurrence (list) --
Specifies which occurrence of a weekday within the month the event should occur on. Must be used with MONTHLY or YEARLY frequency.
Example: 2 corresponds to second occurrence of the weekday in the month. -1 corresponds to last occurrence of the weekday in the month
The weekday itself is specified separately in the HoursOfOperationConfig. Example: To schedule the recurring event for the 2nd Thursday of April every year, set ByWeekdayOccurrence=[2], Day=THURSDAY, ByMonth=[4], Frequency: YEARLY and INTERVAL=1.
(integer) --
OverrideType (string) --
Whether the override will be defined as a standard or as a recurring event.
{'EffectiveOverrideHoursList': [{'Date': 'string',
'OverrideHours': [{'End': {'Hours': 'integer',
'Minutes': 'integer'},
'OperationalStatus': 'OPEN '
'| '
'CLOSED',
'OverrideName': 'string',
'Start': {'Hours': 'integer',
'Minutes': 'integer'}}]}]}
Get the hours of operations with the effective override applied.
See also: AWS API Documentation
Request Syntax
client.get_effective_hours_of_operations(
InstanceId='string',
HoursOfOperationId='string',
FromDate='string',
ToDate='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance.
string
[REQUIRED]
The identifier for the hours of operation.
string
[REQUIRED]
The date from when the hours of operation are listed.
string
[REQUIRED]
The date until when the hours of operation are listed.
dict
Response Syntax
{
'EffectiveHoursOfOperationList': [
{
'Date': 'string',
'OperationalHours': [
{
'Start': {
'Hours': 123,
'Minutes': 123
},
'End': {
'Hours': 123,
'Minutes': 123
}
},
]
},
],
'EffectiveOverrideHoursList': [
{
'Date': 'string',
'OverrideHours': [
{
'Start': {
'Hours': 123,
'Minutes': 123
},
'End': {
'Hours': 123,
'Minutes': 123
},
'OverrideName': 'string',
'OperationalStatus': 'OPEN'|'CLOSED'
},
]
},
],
'TimeZone': 'string'
}
Response Structure
(dict) --
EffectiveHoursOfOperationList (list) --
Information about the effective hours of operations.
(dict) --
Information about the hours of operations with the effective override applied.
Date (string) --
The date that the hours of operation or overrides applies to.
OperationalHours (list) --
Information about the hours of operations with the effective override applied.
(dict) --
Information about the hours of operations with the effective override applied.
Start (dict) --
The start time that your contact center opens.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
End (dict) --
The end time that your contact center closes.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
EffectiveOverrideHoursList (list) --
Information about override configurations applied to the base hours of operation to calculate the effective hours.
For more information about how override types are applied, see Build your list of overrides in the Administrator Guide.
(dict) --
Information about the hours of operation overrides which contribute to effective hours of operations.
Date (string) --
The date that the hours of operation override applies to.
OverrideHours (list) --
Information about the hours of operation overrides that apply to a specific date.
(dict) --
Information about hours of operation override
Start (dict) --
The start time or end time for an hours of operation override.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
End (dict) --
The start time or end time for an hours of operation override.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
OverrideName (string) --
Unique identifier name for the override.
OperationalStatus (string) --
Indicates whether the status is open or closed during the override period. This status determines how the override modifies the base hours of operation schedule.
TimeZone (string) --
The time zone for the hours of operation.
{'HoursOfOperationOverrideList': {'OverrideType': 'STANDARD | OPEN | CLOSED',
'RecurrenceConfig': {'RecurrencePattern': {'ByMonth': ['integer'],
'ByMonthDay': ['integer'],
'ByWeekdayOccurrence': ['integer'],
'Frequency': 'WEEKLY '
'| '
'MONTHLY '
'| '
'YEARLY',
'Interval': 'integer'}}}}
List the hours of operation overrides.
See also: AWS API Documentation
Request Syntax
client.list_hours_of_operation_overrides(
InstanceId='string',
HoursOfOperationId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance.
string
[REQUIRED]
The identifier for the hours of operation.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
integer
The maximum number of results to return per page.
dict
Response Syntax
{
'NextToken': 'string',
'HoursOfOperationOverrideList': [
{
'HoursOfOperationOverrideId': 'string',
'HoursOfOperationId': 'string',
'HoursOfOperationArn': 'string',
'Name': 'string',
'Description': 'string',
'Config': [
{
'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'StartTime': {
'Hours': 123,
'Minutes': 123
},
'EndTime': {
'Hours': 123,
'Minutes': 123
}
},
],
'EffectiveFrom': 'string',
'EffectiveTill': 'string',
'RecurrenceConfig': {
'RecurrencePattern': {
'Frequency': 'WEEKLY'|'MONTHLY'|'YEARLY',
'Interval': 123,
'ByMonth': [
123,
],
'ByMonthDay': [
123,
],
'ByWeekdayOccurrence': [
123,
]
}
},
'OverrideType': 'STANDARD'|'OPEN'|'CLOSED'
},
],
'LastModifiedRegion': 'string',
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
NextToken (string) --
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
HoursOfOperationOverrideList (list) --
Information about the hours of operation override.
(dict) --
Information about the hours of operations override.
HoursOfOperationOverrideId (string) --
The identifier for the hours of operation override.
HoursOfOperationId (string) --
The identifier for the hours of operation.
HoursOfOperationArn (string) --
The Amazon Resource Name (ARN) for the hours of operation.
Name (string) --
The name of the hours of operation override.
Description (string) --
The description of the hours of operation override.
Config (list) --
Configuration information for the hours of operation override: day, start time, and end time.
(dict) --
Information about the hours of operation override config: day, start time, and end time.
Day (string) --
The day that the hours of operation override applies to.
StartTime (dict) --
The start time when your contact center opens if overrides are applied.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
EndTime (dict) --
The end time that your contact center closes if overrides are applied.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
EffectiveFrom (string) --
The date from which the hours of operation override would be effective.
EffectiveTill (string) --
The date until the hours of operation override is effective.
RecurrenceConfig (dict) --
Configuration for a recurring event.
RecurrencePattern (dict) --
The recurrence pattern that defines how the event repeats. Example: Frequency, Interval, ByMonth, ByMonthDay, ByWeekdayOccurrence
Frequency (string) --
Defines how often the pattern repeats. This is the base unit for the recurrence schedule and works in conjunction with the Interval field to determine the exact repetition sequence.
Interval (integer) --
Specifies the number of frequency units between each occurrence. Must be a positive integer.
Examples: To repeat every week, set Interval=1 with WEEKLY frequency. To repeat every two months, set Interval=2 with MONTHLY frequency.
ByMonth (list) --
Specifies which month the event should occur in (1-12, where 1=January, 12=December). Used with YEARLY frequency to schedule events in specific month.
Note: It does not accept multiple values in the same list
(integer) --
ByMonthDay (list) --
Specifies which day of the month the event should occur on (1-31). Used with MONTHLY or YEARLY frequency to schedule events on specific date within a month.
Examples: [15] for events on the 15th of each month, [-1] for events on the last day of month.
Note: It does not accept multiple values in the same list. If a specified day doesn't exist in a particular month (e.g., day 31 in February), the event will be skipped for that month. This field cannot be used simultaneously with ByWeekdayOccurrence as they represent different scheduling approaches (specific dates vs. relative weekday positions).
(integer) --
ByWeekdayOccurrence (list) --
Specifies which occurrence of a weekday within the month the event should occur on. Must be used with MONTHLY or YEARLY frequency.
Example: 2 corresponds to second occurrence of the weekday in the month. -1 corresponds to last occurrence of the weekday in the month
The weekday itself is specified separately in the HoursOfOperationConfig. Example: To schedule the recurring event for the 2nd Thursday of April every year, set ByWeekdayOccurrence=[2], Day=THURSDAY, ByMonth=[4], Frequency: YEARLY and INTERVAL=1.
(integer) --
OverrideType (string) --
Whether the override will be defined as a standard or as a recurring event.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
{'HoursOfOperationOverrides': {'OverrideType': 'STANDARD | OPEN | CLOSED',
'RecurrenceConfig': {'RecurrencePattern': {'ByMonth': ['integer'],
'ByMonthDay': ['integer'],
'ByWeekdayOccurrence': ['integer'],
'Frequency': 'WEEKLY '
'| '
'MONTHLY '
'| '
'YEARLY',
'Interval': 'integer'}}}}
Searches the hours of operation overrides.
See also: AWS API Documentation
Request Syntax
client.search_hours_of_operation_overrides(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
},
'DateCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'
}
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
integer
The maximum number of results to return per page.
dict
Filters to be applied to search results.
TagFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(list) --
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
TagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
The search criteria to be used to return hours of operations overrides.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return hours of operations overrides.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return hours of operations overrides.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
FieldName (string) --
The name of the field in the string condition.
Value (string) --
The value of the string.
ComparisonType (string) --
The type of comparison to be made when evaluating the string condition.
DateCondition (dict) --
A leaf node condition which can be used to specify a date condition.
FieldName (string) --
An object to specify the hours of operation override date field.
Value (string) --
An object to specify the hours of operation override date value.
ComparisonType (string) --
An object to specify the hours of operation override date condition comparisonType.
dict
Response Syntax
{
'HoursOfOperationOverrides': [
{
'HoursOfOperationOverrideId': 'string',
'HoursOfOperationId': 'string',
'HoursOfOperationArn': 'string',
'Name': 'string',
'Description': 'string',
'Config': [
{
'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'StartTime': {
'Hours': 123,
'Minutes': 123
},
'EndTime': {
'Hours': 123,
'Minutes': 123
}
},
],
'EffectiveFrom': 'string',
'EffectiveTill': 'string',
'RecurrenceConfig': {
'RecurrencePattern': {
'Frequency': 'WEEKLY'|'MONTHLY'|'YEARLY',
'Interval': 123,
'ByMonth': [
123,
],
'ByMonthDay': [
123,
],
'ByWeekdayOccurrence': [
123,
]
}
},
'OverrideType': 'STANDARD'|'OPEN'|'CLOSED'
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
HoursOfOperationOverrides (list) --
Information about the hours of operations overrides.
(dict) --
Information about the hours of operations override.
HoursOfOperationOverrideId (string) --
The identifier for the hours of operation override.
HoursOfOperationId (string) --
The identifier for the hours of operation.
HoursOfOperationArn (string) --
The Amazon Resource Name (ARN) for the hours of operation.
Name (string) --
The name of the hours of operation override.
Description (string) --
The description of the hours of operation override.
Config (list) --
Configuration information for the hours of operation override: day, start time, and end time.
(dict) --
Information about the hours of operation override config: day, start time, and end time.
Day (string) --
The day that the hours of operation override applies to.
StartTime (dict) --
The start time when your contact center opens if overrides are applied.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
EndTime (dict) --
The end time that your contact center closes if overrides are applied.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
EffectiveFrom (string) --
The date from which the hours of operation override would be effective.
EffectiveTill (string) --
The date until the hours of operation override is effective.
RecurrenceConfig (dict) --
Configuration for a recurring event.
RecurrencePattern (dict) --
The recurrence pattern that defines how the event repeats. Example: Frequency, Interval, ByMonth, ByMonthDay, ByWeekdayOccurrence
Frequency (string) --
Defines how often the pattern repeats. This is the base unit for the recurrence schedule and works in conjunction with the Interval field to determine the exact repetition sequence.
Interval (integer) --
Specifies the number of frequency units between each occurrence. Must be a positive integer.
Examples: To repeat every week, set Interval=1 with WEEKLY frequency. To repeat every two months, set Interval=2 with MONTHLY frequency.
ByMonth (list) --
Specifies which month the event should occur in (1-12, where 1=January, 12=December). Used with YEARLY frequency to schedule events in specific month.
Note: It does not accept multiple values in the same list
(integer) --
ByMonthDay (list) --
Specifies which day of the month the event should occur on (1-31). Used with MONTHLY or YEARLY frequency to schedule events on specific date within a month.
Examples: [15] for events on the 15th of each month, [-1] for events on the last day of month.
Note: It does not accept multiple values in the same list. If a specified day doesn't exist in a particular month (e.g., day 31 in February), the event will be skipped for that month. This field cannot be used simultaneously with ByWeekdayOccurrence as they represent different scheduling approaches (specific dates vs. relative weekday positions).
(integer) --
ByWeekdayOccurrence (list) --
Specifies which occurrence of a weekday within the month the event should occur on. Must be used with MONTHLY or YEARLY frequency.
Example: 2 corresponds to second occurrence of the weekday in the month. -1 corresponds to last occurrence of the weekday in the month
The weekday itself is specified separately in the HoursOfOperationConfig. Example: To schedule the recurring event for the 2nd Thursday of April every year, set ByWeekdayOccurrence=[2], Day=THURSDAY, ByMonth=[4], Frequency: YEARLY and INTERVAL=1.
(integer) --
OverrideType (string) --
Whether the override will be defined as a standard or as a recurring event.
NextToken (string) --
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
ApproximateTotalCount (integer) --
The total number of hours of operations which matched your search query.
{'HoursOfOperations': {'ParentHoursOfOperations': [{'Arn': 'string',
'Id': 'string',
'Name': 'string'}]}}
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
See also: AWS API Documentation
Request Syntax
client.search_hours_of_operations(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
}
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
integer
The maximum number of results to return per page.
dict
Filters to be applied to search results.
TagFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(list) --
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
TagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
The search criteria to be used to return hours of operations.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return hours of operations.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return hours of operations.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
FieldName (string) --
The name of the field in the string condition.
Value (string) --
The value of the string.
ComparisonType (string) --
The type of comparison to be made when evaluating the string condition.
dict
Response Syntax
{
'HoursOfOperations': [
{
'HoursOfOperationId': 'string',
'HoursOfOperationArn': 'string',
'Name': 'string',
'Description': 'string',
'TimeZone': 'string',
'Config': [
{
'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'StartTime': {
'Hours': 123,
'Minutes': 123
},
'EndTime': {
'Hours': 123,
'Minutes': 123
}
},
],
'ParentHoursOfOperations': [
{
'Name': 'string',
'Id': 'string',
'Arn': 'string'
},
],
'Tags': {
'string': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
HoursOfOperations (list) --
Information about the hours of operations.
(dict) --
Information about of the hours of operation.
HoursOfOperationId (string) --
The identifier for the hours of operation.
HoursOfOperationArn (string) --
The Amazon Resource Name (ARN) for the hours of operation.
Name (string) --
The name for the hours of operation.
Description (string) --
The description for the hours of operation.
TimeZone (string) --
The time zone for the hours of operation.
Config (list) --
Configuration information for the hours of operation.
(dict) --
Contains information about the hours of operation.
Day (string) --
The day that the hours of operation applies to.
StartTime (dict) --
The start time that your contact center opens.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
EndTime (dict) --
The end time that your contact center closes.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
ParentHoursOfOperations (list) --
Information about parent hours of operations.
(dict) --
Identifier for a hours of operations resource: ARN, ID, Name
Name (string) --
Name of the hours of operation
Id (string) --
Unique identifier of the hours of operation.
Arn (string) --
Amazon Resource Name (ARN) of the hours of operations.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of hours of operations which matched your search query.
{'OverrideType': 'STANDARD | OPEN | CLOSED',
'RecurrenceConfig': {'RecurrencePattern': {'ByMonth': ['integer'],
'ByMonthDay': ['integer'],
'ByWeekdayOccurrence': ['integer'],
'Frequency': 'WEEKLY | MONTHLY | '
'YEARLY',
'Interval': 'integer'}}}
Update the hours of operation override.
See also: AWS API Documentation
Request Syntax
client.update_hours_of_operation_override(
InstanceId='string',
HoursOfOperationId='string',
HoursOfOperationOverrideId='string',
Name='string',
Description='string',
Config=[
{
'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'StartTime': {
'Hours': 123,
'Minutes': 123
},
'EndTime': {
'Hours': 123,
'Minutes': 123
}
},
],
EffectiveFrom='string',
EffectiveTill='string',
RecurrenceConfig={
'RecurrencePattern': {
'Frequency': 'WEEKLY'|'MONTHLY'|'YEARLY',
'Interval': 123,
'ByMonth': [
123,
],
'ByMonthDay': [
123,
],
'ByWeekdayOccurrence': [
123,
]
}
},
OverrideType='STANDARD'|'OPEN'|'CLOSED'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance.
string
[REQUIRED]
The identifier for the hours of operation.
string
[REQUIRED]
The identifier for the hours of operation override.
string
The name of the hours of operation override.
string
The description of the hours of operation override.
list
Configuration information for the hours of operation override: day, start time, and end time.
(dict) --
Information about the hours of operation override config: day, start time, and end time.
Day (string) --
The day that the hours of operation override applies to.
StartTime (dict) --
The start time when your contact center opens if overrides are applied.
Hours (integer) -- [REQUIRED]
The hours.
Minutes (integer) -- [REQUIRED]
The minutes.
EndTime (dict) --
The end time that your contact center closes if overrides are applied.
Hours (integer) -- [REQUIRED]
The hours.
Minutes (integer) -- [REQUIRED]
The minutes.
string
The date from when the hours of operation override would be effective.
string
The date until the hours of operation override is effective.
dict
Configuration for a recurring event.
RecurrencePattern (dict) -- [REQUIRED]
The recurrence pattern that defines how the event repeats. Example: Frequency, Interval, ByMonth, ByMonthDay, ByWeekdayOccurrence
Frequency (string) -- [REQUIRED]
Defines how often the pattern repeats. This is the base unit for the recurrence schedule and works in conjunction with the Interval field to determine the exact repetition sequence.
Interval (integer) -- [REQUIRED]
Specifies the number of frequency units between each occurrence. Must be a positive integer.
Examples: To repeat every week, set Interval=1 with WEEKLY frequency. To repeat every two months, set Interval=2 with MONTHLY frequency.
ByMonth (list) --
Specifies which month the event should occur in (1-12, where 1=January, 12=December). Used with YEARLY frequency to schedule events in specific month.
Note: It does not accept multiple values in the same list
(integer) --
ByMonthDay (list) --
Specifies which day of the month the event should occur on (1-31). Used with MONTHLY or YEARLY frequency to schedule events on specific date within a month.
Examples: [15] for events on the 15th of each month, [-1] for events on the last day of month.
Note: It does not accept multiple values in the same list. If a specified day doesn't exist in a particular month (e.g., day 31 in February), the event will be skipped for that month. This field cannot be used simultaneously with ByWeekdayOccurrence as they represent different scheduling approaches (specific dates vs. relative weekday positions).
(integer) --
ByWeekdayOccurrence (list) --
Specifies which occurrence of a weekday within the month the event should occur on. Must be used with MONTHLY or YEARLY frequency.
Example: 2 corresponds to second occurrence of the weekday in the month. -1 corresponds to last occurrence of the weekday in the month
The weekday itself is specified separately in the HoursOfOperationConfig. Example: To schedule the recurring event for the 2nd Thursday of April every year, set ByWeekdayOccurrence=[2], Day=THURSDAY, ByMonth=[4], Frequency: YEARLY and INTERVAL=1.
(integer) --
string
Whether the override will be defined as a standard or as a recurring event.
For more information about how override types are applied, see Build your list of overrides in the Administrator Guide.
None