hours_of_operations

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

Overview

Name	hours_of_operations
Type	Resource
Id	aws.connect.hours_of_operations

Fields

The following fields are returned by SELECT queries:

describe_hours_of_operation

Name	Datatype	Description
config	array	Configuration information for the hours of operation.
description	string	The description for the hours of operation.
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.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
name	string	The name for the hours of operation.
parent_hours_of_operations	array	Information about parent hours of operations.
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
time_zone	string	The time zone for the hours of operation.

list_hours_of_operations

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the hours of operation.
id	string	The identifier of the hours of operation.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
name	string	The name of the hours of operation.

search_hours_of_operations

Name	Datatype	Description
config	array	Configuration information for the hours of operation.
description	string	The description for the hours of operation.
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.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
name	string	The name for the hours of operation.
parent_hours_of_operations	array	Information about parent hours of operations.
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
time_zone	string	The time zone for the hours of operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_hours_of_operation	select	instance_id, hours_of_operation_id, region		Describes the hours of operation.
list_hours_of_operations	select	instance_id, region	nextToken, maxResults	Provides information about the hours of operation for the specified Connect Customer instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Connect Customer Administrator Guide.
search_hours_of_operations	select	region		Searches the hours of operation in an Connect Customer instance, with optional filtering.
create_hours_of_operation	insert	instance_id, region, TimeZone		Creates hours of operation.
associate_hours_of_operations	update	instance_id, hours_of_operation_id, region, ParentHoursOfOperationConfigs		Associates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation, see Hours of operation overrides in the Administrator Guide.
disassociate_hours_of_operations	update	instance_id, hours_of_operation_id, region, ParentHoursOfOperationIds		Disassociates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation, see Hours of operation overrides in the Administrator Guide.
update_queue_hours_of_operation	update	instance_id, queue_id, region, HoursOfOperationId		Updates the hours of operation for the specified queue.
update_hours_of_operation	update	instance_id, hours_of_operation_id, region		Updates the hours of operation.
delete_hours_of_operation	delete	instance_id, hours_of_operation_id, region		Deletes an hours of operation.

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.
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
queue_id	string	The identifier for the queue.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page. The default MaxResult size is 100.
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

Describes the hours of operation.

SELECT
config,
description,
hours_of_operation_arn,
hours_of_operation_id,
last_modified_region,
last_modified_time,
name,
parent_hours_of_operations,
tags,
time_zone
FROM aws.connect.hours_of_operations
WHERE instance_id = '{{ instance_id }}' -- required
AND hours_of_operation_id = '{{ hours_of_operation_id }}' -- required
AND region = '{{ region }}' -- required
;

list_hours_of_operations

Provides information about the hours of operation for the specified Connect Customer instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Connect Customer Administrator Guide.

SELECT
arn,
id,
last_modified_region,
last_modified_time,
name
FROM aws.connect.hours_of_operations
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

search_hours_of_operations

Searches the hours of operation in an Connect Customer instance, with optional filtering.

SELECT
config,
description,
hours_of_operation_arn,
hours_of_operation_id,
last_modified_region,
last_modified_time,
name,
parent_hours_of_operations,
tags,
time_zone
FROM aws.connect.hours_of_operations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_hours_of_operation

Creates hours of operation.

INSERT INTO aws.connect.hours_of_operations (
Name,
Description,
TimeZone,
Config,
ParentHoursOfOperationConfigs,
Tags,
instance_id,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ TimeZone }}' /* required */,
'{{ Config }}',
'{{ ParentHoursOfOperationConfigs }}',
'{{ Tags }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
hours_of_operation_arn,
hours_of_operation_id
;

Manifest

# Description fields are for documentation purposes
- name: hours_of_operations
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the hours_of_operations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the hours_of_operations resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: TimeZone
    value: "{{ TimeZone }}"
  - name: Config
    value:
      - Day: "{{ Day }}"
        StartTime:
          Hours: {{ Hours }}
          Minutes: {{ Minutes }}
        EndTime:
          Hours: {{ Hours }}
          Minutes: {{ Minutes }}
  - name: ParentHoursOfOperationConfigs
    value:
      - HoursOfOperationId: "{{ HoursOfOperationId }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

associate_hours_of_operations

Associates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation, see Hours of operation overrides in the Administrator Guide.

UPDATE aws.connect.hours_of_operations
SET 
ParentHoursOfOperationConfigs = '{{ ParentHoursOfOperationConfigs }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND hours_of_operation_id = '{{ hours_of_operation_id }}' --required
AND region = '{{ region }}' --required
AND ParentHoursOfOperationConfigs = '{{ ParentHoursOfOperationConfigs }}' --required;

disassociate_hours_of_operations

Disassociates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation, see Hours of operation overrides in the Administrator Guide.

UPDATE aws.connect.hours_of_operations
SET 
ParentHoursOfOperationIds = '{{ ParentHoursOfOperationIds }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND hours_of_operation_id = '{{ hours_of_operation_id }}' --required
AND region = '{{ region }}' --required
AND ParentHoursOfOperationIds = '{{ ParentHoursOfOperationIds }}' --required;

update_queue_hours_of_operation

Updates the hours of operation for the specified queue.

UPDATE aws.connect.hours_of_operations
SET 
HoursOfOperationId = '{{ HoursOfOperationId }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND region = '{{ region }}' --required
AND HoursOfOperationId = '{{ HoursOfOperationId }}' --required;

update_hours_of_operation

Updates the hours of operation.

UPDATE aws.connect.hours_of_operations
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
TimeZone = '{{ TimeZone }}',
Config = '{{ Config }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND hours_of_operation_id = '{{ hours_of_operation_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_hours_of_operation

Deletes an hours of operation.

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