Connect / Client / list_hours_of_operation_overrides

list_hours_of_operation_overrides#

Connect.Client.list_hours_of_operation_overrides(**kwargs)#

List the hours of operation overrides.

See also: AWS API Documentation

Request Syntax

response = client.list_hours_of_operation_overrides(
    InstanceId='string',
    HoursOfOperationId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:
  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • HoursOfOperationId (string) –

    [REQUIRED]

    The identifier for the hours of operation

  • 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.

  • MaxResults (integer) – The maximum number of results to return per page. The default MaxResult size is 100. Valid Range: Minimum value of 1. Maximum value of 1000.

Return type:

dict

Returns:

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'
        },
    ],
    '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 till which the hours of operation override would be effective.

    • LastModifiedRegion (string) –

      The AWS Region where this resource was last modified.

    • LastModifiedTime (datetime) –

      The timestamp when this resource was last modified.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException