Connect / Paginator / SearchQueues

SearchQueues#

class Connect.Paginator.SearchQueues#

paginator = client.get_paginator('search_queues')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from Connect.Client.search_queues().

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'
        },
        'QueueTypeCondition': 'STANDARD'
    },
    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 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 queues.

Note
The name and description fields support “contains” queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
- OrConditions (list) –
  
  A list of conditions which would be applied together with an OR condition.
  - (dict) –
    
    The search criteria to be used to return queues.
    
    Note
    The name and description fields support “contains” queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
- AndConditions (list) –
  
  A list of conditions which would be applied together with an AND condition.
  - (dict) –
    
    The search criteria to be used to return queues.
    
    Note
    The name and description fields support “contains” queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
- StringCondition (dict) –
  
  A leaf node condition which can be used to specify a string condition.
  
  Note
  The currently supported values for FieldName are name, description, and resourceID.
  - 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.
- QueueTypeCondition (string) –
  
  The type of queue.
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

{
    'Queues': [
        {
            'Name': 'string',
            'QueueArn': 'string',
            'QueueId': 'string',
            'Description': 'string',
            'OutboundCallerConfig': {
                'OutboundCallerIdName': 'string',
                'OutboundCallerIdNumberId': 'string',
                'OutboundFlowId': 'string'
            },
            'OutboundEmailConfig': {
                'OutboundEmailAddressId': 'string'
            },
            'HoursOfOperationId': 'string',
            'MaxContacts': 123,
            'Status': 'ENABLED'|'DISABLED',
            'Tags': {
                'string': 'string'
            },
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ],
    'ApproximateTotalCount': 123
}

Response Structure

(dict) –
- Queues (list) –
  
  Information about the queues.
  - (dict) –
    
    Contains information about a queue.
    - Name (string) –
      
      The name of the queue.
    - QueueArn (string) –
      
      The Amazon Resource Name (ARN) for the queue.
    - QueueId (string) –
      
      The identifier for the queue.
    - Description (string) –
      
      The description of the queue.
    - OutboundCallerConfig (dict) –
      
      The outbound caller ID name, number, and outbound whisper flow.
      - OutboundCallerIdName (string) –
        
        The caller ID name.
      - OutboundCallerIdNumberId (string) –
        
        The caller ID number.
      - OutboundFlowId (string) –
        
        The outbound whisper flow to be used during an outbound call.
    - OutboundEmailConfig (dict) –
      
      The outbound email address ID for a specified queue.
      - OutboundEmailAddressId (string) –
        
        The identifier of the email address.
    - HoursOfOperationId (string) –
      
      The identifier for the hours of operation.
    - MaxContacts (integer) –
      
      The maximum number of contacts that can be in the queue before it is considered full.
    - Status (string) –
      
      The status of the queue.
    - 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 queues which matched your search query.