Connect / Client / search_contact_flows

search_contact_flows#

Connect.Client.search_contact_flows(**kwargs)#

Searches the flows in an Amazon Connect instance, with optional filtering.

Request Syntax

response = client.search_contact_flows(
    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'
        },
        'TypeCondition': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
        'StateCondition': 'ACTIVE'|'ARCHIVED',
        'StatusCondition': 'PUBLISHED'|'SAVED'
    }
)

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

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 result in 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 flows.
- AndConditions (list) –
  
  A list of conditions which would be applied together with an AND condition.
  - (dict) –
    
    The search criteria to be used to return flows.
- 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.
- TypeCondition (string) –
  
  The type of flow.
- StateCondition (string) –
  
  The state of the flow.
- StatusCondition (string) –
  
  The status of the flow.

Return type:

dict

Returns:

Response Syntax

{
    'ContactFlows': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Name': 'string',
            'Type': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
            'State': 'ACTIVE'|'ARCHIVED',
            'Status': 'PUBLISHED'|'SAVED',
            'Description': 'string',
            'Content': 'string',
            'Tags': {
                'string': 'string'
            },
            'FlowContentSha256': 'string',
            'Version': 123,
            'VersionDescription': 'string',
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ],
    'NextToken': 'string',
    'ApproximateTotalCount': 123
}

Response Structure

(dict) –
- ContactFlows (list) –
  
  Information about the flows.
  - (dict) –
    
    Contains information about a flow.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the flow.
    - Id (string) –
      
      The identifier of the flow.
    - Name (string) –
      
      The name of the flow.
    - Type (string) –
      
      The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
    - State (string) –
      
      The type of flow.
    - Status (string) –
      
      The status of the flow.
    - Description (string) –
      
      The description of the flow.
    - Content (string) –
      
      The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
      
      Length Constraints: Minimum length of 1. Maximum length of 256000.
    - Tags (dict) –
      
      The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.
      - (string) –
        
        (string) –
    - FlowContentSha256 (string) –
      
      Indicates the checksum value of the flow content.
    - Version (integer) –
      
      The identifier of the flow version.
    - VersionDescription (string) –
      
      The description of the flow version.
    - LastModifiedTime (datetime) –
      
      The time at which the flow was last modified.
    - LastModifiedRegion (string) –
      
      The region in which the flow was last modified
- NextToken (string) –
  
  If there are additional results, this is the token for the next set of results.
- ApproximateTotalCount (integer) –
  
  The total number of flows 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