Search Quick Connects

connect_search_quick_connects

R Documentation

Searches quick connects in an Amazon Connect instance, with optional filtering

Description

Searches quick connects in an Amazon Connect instance, with optional filtering.

Usage

connect_search_quick_connects(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 quick connects.

Value

A list with the following syntax:

list(
  QuickConnects = list(
    list(
      QuickConnectARN = "string",
      QuickConnectId = "string",
      Name = "string",
      Description = "string",
      QuickConnectConfig = list(
        QuickConnectType = "USER"|"QUEUE"|"PHONE_NUMBER",
        UserConfig = list(
          UserId = "string",
          ContactFlowId = "string"
        ),
        QueueConfig = list(
          QueueId = "string",
          ContactFlowId = "string"
        ),
        PhoneConfig = list(
          PhoneNumber = "string"
        )
      ),
      Tags = list(
        "string"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedRegion = "string"
    )
  ),
  NextToken = "string",
  ApproximateTotalCount = 123
)

Request syntax

svc$search_quick_connects(
  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"
    )
  )
)