Connect / Paginator / SearchHoursOfOperations
SearchHoursOfOperations#
- class Connect.Paginator.SearchHoursOfOperations#
paginator = client.get_paginator('search_hours_of_operations')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
Connect.Client.search_hours_of_operations()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( InstanceId='string', 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' } }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
InstanceId (string) –
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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 anOR
ofAND
(List of List) input where:Top level list specifies conditions that need to be applied with
OR
operatorInner 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.
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.
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.
StringCondition (dict) –
A leaf node condition which can be used to specify a string condition.
Note
The currently supported values for
FieldName
arename
,description
,timezone
, andresourceID
.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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'HoursOfOperations': [ { 'HoursOfOperationId': 'string', 'HoursOfOperationArn': 'string', 'Name': 'string', 'Description': 'string', 'TimeZone': 'string', 'Config': [ { 'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY', 'StartTime': { 'Hours': 123, 'Minutes': 123 }, 'EndTime': { 'Hours': 123, 'Minutes': 123 } }, ], 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'ApproximateTotalCount': 123 }
Response Structure
(dict) –
HoursOfOperations (list) –
Information about the hours of operations.
(dict) –
Information about of the hours of operation.
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 for the hours of operation.
Description (string) –
The description for the hours of operation.
TimeZone (string) –
The time zone for the hours of operation.
Config (list) –
Configuration information for the hours of operation.
(dict) –
Contains information about the hours of operation.
Day (string) –
The day that the hours of operation applies to.
StartTime (dict) –
The start time that your contact center opens.
Hours (integer) –
The hours.
Minutes (integer) –
The minutes.
EndTime (dict) –
The end time that your contact center closes.
Hours (integer) –
The hours.
Minutes (integer) –
The minutes.
Tags (dict) –
The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.
(string) –
(string) –
LastModifiedTime (datetime) –
The timestamp when this resource was last modified.
LastModifiedRegion (string) –
The Amazon Web Services Region where this resource was last modified.
ApproximateTotalCount (integer) –
The total number of hours of operations which matched your search query.