Connect / Client / get_effective_hours_of_operations

get_effective_hours_of_operations

Connect.Client.get_effective_hours_of_operations(**kwargs)

Get the hours of operations with the effective override applied.

See also: AWS API Documentation

Request Syntax

response = client.get_effective_hours_of_operations(
    InstanceId='string',
    HoursOfOperationId='string',
    FromDate='string',
    ToDate='string'
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The identifier of the Amazon Connect instance.

• HoursOfOperationId (string) –

  [REQUIRED]

  The identifier for the hours of operation.

• FromDate (string) –

  [REQUIRED]

  The date from when the hours of operation are listed.

• ToDate (string) –

  [REQUIRED]

  The date until when the hours of operation are listed.

Return type:

dict

Returns:

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.

Exceptions

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.InvalidParameterException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.InternalServiceException