CreateHoursOfOperation - Amazon Connect

CreateHoursOfOperation

This API is in preview release for Amazon Connect and is subject to change.

Creates hours of operation.

Request Syntax

PUT /hours-of-operations/InstanceId HTTP/1.1 Content-type: application/json { "Config": [ { "Day": "string", "EndTime": { "Hours": number, "Minutes": number }, "StartTime": { "Hours": number, "Minutes": number } } ], "Description": "string", "Name": "string", "Tags": { "string" : "string" }, "TimeZone": "string" }

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Config

Configuration information for the hours of operation: day, start time, and end time.

Type: Array of HoursOfOperationConfig objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: Yes

Description

The description of the hours of operation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 250.

Required: No

Name

The name of the hours of operation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 127.

Required: Yes

Tags

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$

Value Length Constraints: Maximum length of 256.

Required: No

TimeZone

The time zone of the hours of operation.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "HoursOfOperationArn": "string", "HoursOfOperationId": "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.

HoursOfOperationArn

The Amazon Resource Name (ARN) for the hours of operation.

Type: String

HoursOfOperationId

The identifier for the hours of operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DuplicateResourceException

A resource with the specified name already exists.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

LimitExceededException

The allowed limit for the resource has been exceeded.

HTTP Status Code: 429

ResourceNotFoundException

The specified resource was not found.

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: