Search Predefined Attributes

connect_search_predefined_attributes

R Documentation

Searches predefined attributes that meet certain criteria¶

Description¶

Searches predefined attributes that meet certain criteria. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.

Usage¶

connect_search_predefined_attributes(InstanceId, NextToken, MaxResults,
  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.
SearchCriteria: The search criteria to be used to return predefined attributes.

Value¶

A list with the following syntax:

list(
  PredefinedAttributes = list(
    list(
      Name = "string",
      Values = list(
        StringList = list(
          "string"
        )
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedRegion = "string"
    )
  ),
  NextToken = "string",
  ApproximateTotalCount = 123
)

Request syntax¶

svc$search_predefined_attributes(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123,
  SearchCriteria = list(
    OrConditions = list(
      list()
    ),
    AndConditions = list(
      list()
    ),
    StringCondition = list(
      FieldName = "string",
      Value = "string",
      ComparisonType = "STARTS_WITH"|"CONTAINS"|"EXACT"
    )
  )
)