Search Contact Flows

connect_search_contact_flows

R Documentation

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

Description¶

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

Usage¶

connect_search_contact_flows(InstanceId, NextToken, MaxResults,
  SearchFilter, SearchCriteria)

Arguments¶

InstanceId

[required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

NextToken

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

The maximum number of results to return per page.

SearchFilter

Filters to be applied to search results.

SearchCriteria

The search criteria to be used to return flows.

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.

Value¶

A list with the following syntax:

list(
  ContactFlows = list(
    list(
      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 = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  ApproximateTotalCount = 123
)

Request syntax¶

svc$search_contact_flows(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123,
  SearchFilter = list(
    TagFilter = list(
      OrConditions = list(
        list(
          list(
            TagKey = "string",
            TagValue = "string"
          )
        )
      ),
      AndConditions = list(
        list(
          TagKey = "string",
          TagValue = "string"
        )
      ),
      TagCondition = list(
        TagKey = "string",
        TagValue = "string"
      )
    )
  ),
  SearchCriteria = list(
    OrConditions = list(
      list()
    ),
    AndConditions = list(
      list()
    ),
    StringCondition = list(
      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"
  )
)