Connect / Client / search_hours_of_operation_overrides

search_hours_of_operation_overrides#

Connect.Client.search_hours_of_operation_overrides(**kwargs)#

Searches the hours of operation overrides.

Request Syntax

response = client.search_hours_of_operation_overrides(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    SearchFilter={
        'TagFilter': {
            'OrConditions': [
                [
                    {
                        'TagKey': 'string',
                        'TagValue': 'string'
                    },
                ],
            ],
            'AndConditions': [
                {
                    'TagKey': 'string',
                    'TagValue': 'string'
                },
            ],
            'TagCondition': {
                'TagKey': 'string',
                'TagValue': 'string'
            }
        }
    },
    SearchCriteria={
        'OrConditions': [
            {'... recursive ...'},
        ],
        'AndConditions': [
            {'... recursive ...'},
        ],
        'StringCondition': {
            'FieldName': 'string',
            'Value': 'string',
            'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
        },
        'DateCondition': {
            'FieldName': 'string',
            'Value': 'string',
            'ComparisonType': 'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'
        }
    }
)

Parameters:

InstanceId (string) –
[REQUIRED]

The identifier of the Amazon Connect instance.
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. Length Constraints: Minimum length of 1. Maximum length of 2500.
MaxResults (integer) – The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 100.
SearchFilter (dict) –
Filters to be applied to search results.
- TagFilter (dict) –
  
  An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:
  - Top level list specifies conditions that need to be applied with OR operator
  - Inner list specifies conditions that need to be applied with AND operator.
  - OrConditions (list) –
    
    A list of conditions which would be applied together with an OR condition.
    - (list) –
      - (dict) –
        
        A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
        
        TagKey (string) –
        
        The tag key in the tag condition.
        
        TagValue (string) –
        
        The tag value in the tag condition.
  - AndConditions (list) –
    
    A list of conditions which would be applied together with an AND condition.
    - (dict) –
      
      A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
      - TagKey (string) –
        
        The tag key in the tag condition.
      - TagValue (string) –
        
        The tag value in the tag condition.
  - TagCondition (dict) –
    
    A leaf node condition which can be used to specify a tag condition.
    - TagKey (string) –
      
      The tag key in the tag condition.
    - TagValue (string) –
      
      The tag value in the tag condition.
SearchCriteria (dict) –
The search criteria to be used to return hours of operations overrides.
- OrConditions (list) –
  
  A list of conditions which would be applied together with an OR condition.
  - (dict) –
    
    The search criteria to be used to return hours of operations overrides.
- AndConditions (list) –
  
  A list of conditions which would be applied together with an AND condition.
  - (dict) –
    
    The search criteria to be used to return hours of operations overrides.
- StringCondition (dict) –
  
  A leaf node condition which can be used to specify a string condition.
  - FieldName (string) –
    
    The name of the field in the string condition.
  - Value (string) –
    
    The value of the string.
  - ComparisonType (string) –
    
    The type of comparison to be made when evaluating the string condition.
- DateCondition (dict) –
  
  A leaf node condition which can be used to specify a date condition.
  - FieldName (string) –
    
    An object to specify the hours of operation override date field.
  - Value (string) –
    
    An object to specify the hours of operation override date value.
  - ComparisonType (string) –
    
    An object to specify the hours of operation override date condition comparisonType.

Return type:

dict

Returns:

Response Syntax

{
    'HoursOfOperationOverrides': [
        {
            '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'
        },
    ],
    'NextToken': 'string',
    'ApproximateTotalCount': 123
}

Response Structure

(dict) –
- HoursOfOperationOverrides (list) –
  
  Information about the hours of operations overrides.
  - (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.
- 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. Length Constraints: Minimum length of 1. Maximum length of 2500.
- ApproximateTotalCount (integer) –
  
  The total number of hours of operations which matched your search query.

Exceptions

Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.InternalServiceException