hours_of_operation_overrides

Creates, updates, deletes, gets or lists an hours_of_operation_overrides resource.

Overview

Name	hours_of_operation_overrides
Type	Resource
Id	aws.connect.hours_of_operation_overrides

Fields

The following fields are returned by SELECT queries:

describe_hours_of_operation_override

Name	Datatype	Description
config	array	Configuration information for the hours of operation override: day, start time, and end time.
description	string	The description of the hours of operation override. (pattern: <code>^[\P{C}\r\n\t]{1,250}$</code>)
effective_from	string	The date from which the hours of operation override would be effective. (pattern: <code>^\d{4}-\d{2}-\d{2}$</code>)
effective_till	string	The date until the hours of operation override is effective. (pattern: <code>^\d{4}-\d{2}-\d{2}$</code>)
hours_of_operation_arn	string	The Amazon Resource Name (ARN) for the hours of operation.
hours_of_operation_id	string	The identifier for the hours of operation.
hours_of_operation_override_id	string	The identifier for the hours of operation override.
name	string	The name of the hours of operation override. (pattern: <code>^[\P{C}\r\n\t]{1,127}$</code>)
override_type	string	Whether the override will be defined as a standard or as a recurring event. (STANDARD, OPEN, CLOSED)
recurrence_config	object	Defines the recurrence configuration for overrides. This configuration uses a recurrence pattern to specify when and how frequently an event should repeat.

list_hours_of_operation_overrides

Name	Datatype	Description
config	array	Configuration information for the hours of operation override: day, start time, and end time.
description	string	The description of the hours of operation override. (pattern: <code>^[\P{C}\r\n\t]{1,250}$</code>)
effective_from	string	The date from which the hours of operation override would be effective. (pattern: <code>^\d{4}-\d{2}-\d{2}$</code>)
effective_till	string	The date until the hours of operation override is effective. (pattern: <code>^\d{4}-\d{2}-\d{2}$</code>)
hours_of_operation_arn	string	The Amazon Resource Name (ARN) for the hours of operation.
hours_of_operation_id	string	The identifier for the hours of operation.
hours_of_operation_override_id	string	The identifier for the hours of operation override.
name	string	The name of the hours of operation override. (pattern: <code>^[\P{C}\r\n\t]{1,127}$</code>)
override_type	string	Whether the override will be defined as a standard or as a recurring event. (STANDARD, OPEN, CLOSED)
recurrence_config	object	Defines the recurrence configuration for overrides. This configuration uses a recurrence pattern to specify when and how frequently an event should repeat.

search_hours_of_operation_overrides

Name	Datatype	Description
config	array	Configuration information for the hours of operation override: day, start time, and end time.
description	string	The description of the hours of operation override. (pattern: <code>^[\P{C}\r\n\t]{1,250}$</code>)
effective_from	string	The date from which the hours of operation override would be effective. (pattern: <code>^\d{4}-\d{2}-\d{2}$</code>)
effective_till	string	The date until the hours of operation override is effective. (pattern: <code>^\d{4}-\d{2}-\d{2}$</code>)
hours_of_operation_arn	string	The Amazon Resource Name (ARN) for the hours of operation.
hours_of_operation_id	string	The identifier for the hours of operation.
hours_of_operation_override_id	string	The identifier for the hours of operation override.
name	string	The name of the hours of operation override. (pattern: <code>^[\P{C}\r\n\t]{1,127}$</code>)
override_type	string	Whether the override will be defined as a standard or as a recurring event. (STANDARD, OPEN, CLOSED)
recurrence_config	object	Defines the recurrence configuration for overrides. This configuration uses a recurrence pattern to specify when and how frequently an event should repeat.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_hours_of_operation_override	select	instance_id, hours_of_operation_id, hours_of_operation_override_id, region		Describes the hours of operation override.
list_hours_of_operation_overrides	select	instance_id, hours_of_operation_id, region	nextToken, maxResults	List the hours of operation overrides.
search_hours_of_operation_overrides	select	region		Searches the hours of operation overrides.
create_hours_of_operation_override	insert	instance_id, hours_of_operation_id, region, EffectiveFrom, EffectiveTill		Creates an hours of operation override in an Connect Customer hours of operation resource.
update_hours_of_operation_override	update	instance_id, hours_of_operation_id, hours_of_operation_override_id, region		Update the hours of operation override.
delete_hours_of_operation_override	delete	instance_id, hours_of_operation_id, hours_of_operation_override_id, region		Deletes an hours of operation override in an Connect Customer hours of operation resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
hours_of_operation_id	string	The identifier for the hours of operation.
hours_of_operation_override_id	string	The identifier for the hours of operation override.
instance_id	string	The identifier of the Connect Customer instance.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page.
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.

SELECT examples

describe_hours_of_operation_override

Describes the hours of operation override.

SELECT
config,
description,
effective_from,
effective_till,
hours_of_operation_arn,
hours_of_operation_id,
hours_of_operation_override_id,
name,
override_type,
recurrence_config
FROM aws.connect.hours_of_operation_overrides
WHERE instance_id = '{{ instance_id }}' -- required
AND hours_of_operation_id = '{{ hours_of_operation_id }}' -- required
AND hours_of_operation_override_id = '{{ hours_of_operation_override_id }}' -- required
AND region = '{{ region }}' -- required
;

list_hours_of_operation_overrides

List the hours of operation overrides.

SELECT
config,
description,
effective_from,
effective_till,
hours_of_operation_arn,
hours_of_operation_id,
hours_of_operation_override_id,
name,
override_type,
recurrence_config
FROM aws.connect.hours_of_operation_overrides
WHERE instance_id = '{{ instance_id }}' -- required
AND hours_of_operation_id = '{{ hours_of_operation_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

search_hours_of_operation_overrides

Searches the hours of operation overrides.

SELECT
config,
description,
effective_from,
effective_till,
hours_of_operation_arn,
hours_of_operation_id,
hours_of_operation_override_id,
name,
override_type,
recurrence_config
FROM aws.connect.hours_of_operation_overrides
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_hours_of_operation_override

Creates an hours of operation override in an Connect Customer hours of operation resource.

INSERT INTO aws.connect.hours_of_operation_overrides (
Name,
Description,
Config,
EffectiveFrom,
EffectiveTill,
RecurrenceConfig,
OverrideType,
instance_id,
hours_of_operation_id,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ Config }}',
'{{ EffectiveFrom }}' /* required */,
'{{ EffectiveTill }}' /* required */,
'{{ RecurrenceConfig }}',
'{{ OverrideType }}',
'{{ instance_id }}',
'{{ hours_of_operation_id }}',
'{{ region }}'
RETURNING
hours_of_operation_override_id
;

Manifest

# Description fields are for documentation purposes
- name: hours_of_operation_overrides
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the hours_of_operation_overrides resource.
  - name: hours_of_operation_id
    value: "{{ hours_of_operation_id }}"
    description: Required parameter for the hours_of_operation_overrides resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the hours_of_operation_overrides resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: Config
    value:
      - Day: "{{ Day }}"
        StartTime:
          Hours: {{ Hours }}
          Minutes: {{ Minutes }}
        EndTime:
          Hours: {{ Hours }}
          Minutes: {{ Minutes }}
  - name: EffectiveFrom
    value: "{{ EffectiveFrom }}"
  - name: EffectiveTill
    value: "{{ EffectiveTill }}"
  - name: RecurrenceConfig
    description: |
      Defines the recurrence configuration for overrides. This configuration uses a recurrence pattern to specify when and how frequently an event should repeat.
    value:
      RecurrencePattern:
        Frequency: "{{ Frequency }}"
        Interval: {{ Interval }}
        ByMonth:
          - {{ ByMonth }}
        ByMonthDay:
          - {{ ByMonthDay }}
        ByWeekdayOccurrence:
          - {{ ByWeekdayOccurrence }}
  - name: OverrideType
    value: "{{ OverrideType }}"
    valid_values: ['STANDARD', 'OPEN', 'CLOSED']

UPDATE examples

update_hours_of_operation_override

Update the hours of operation override.

UPDATE aws.connect.hours_of_operation_overrides
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
Config = '{{ Config }}',
EffectiveFrom = '{{ EffectiveFrom }}',
EffectiveTill = '{{ EffectiveTill }}',
RecurrenceConfig = '{{ RecurrenceConfig }}',
OverrideType = '{{ OverrideType }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND hours_of_operation_id = '{{ hours_of_operation_id }}' --required
AND hours_of_operation_override_id = '{{ hours_of_operation_override_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_hours_of_operation_override

Deletes an hours of operation override in an Connect Customer hours of operation resource.

DELETE FROM aws.connect.hours_of_operation_overrides
WHERE instance_id = '{{ instance_id }}' --required
AND hours_of_operation_id = '{{ hours_of_operation_id }}' --required
AND hours_of_operation_override_id = '{{ hours_of_operation_override_id }}' --required
AND region = '{{ region }}' --required
;