Skip to content

Searches routing profiles in an Connect Customer instance, with optional filtering

Description

Searches routing profiles in an Connect Customer instance, with optional filtering.

search_routing_profiles does not populate LastModifiedRegion, LastModifiedTime, MediaConcurrencies.CrossChannelBehavior, and AgentAvailabilityTimer in its response, but describe_routing_profile does.

Usage

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

Arguments

  • InstanceId

    [required] The identifier of the Connect Customer 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 routing profiles.

    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.

Value

A list with the following syntax:

list(
  RoutingProfiles = list(
    list(
      InstanceId = "string",
      Name = "string",
      RoutingProfileArn = "string",
      RoutingProfileId = "string",
      Description = "string",
      MediaConcurrencies = list(
        list(
          Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
          Concurrency = 123,
          CrossChannelBehavior = list(
            BehaviorType = "ROUTE_CURRENT_CHANNEL_ONLY"|"ROUTE_ANY_CHANNEL"
          ),
          WorkloadTypeConcurrencies = list(
            list(
              WorkloadType = "string",
              Concurrency = 123,
              CrossChannelWorkloadBehavior = list(
                ChannelWorkloadBehaviorType = "ROUTE_CURRENT_CHANNEL_CURRENT_WORKLOADTYPE_ONLY"|"ROUTE_CURRENT_CHANNEL_ANY_WORKLOADTYPE_ONLY"|"ROUTE_ANY_CHANNEL_ANY_WORKLOAD_TYPE"
              )
            )
          )
        )
      ),
      DefaultOutboundQueueId = "string",
      Tags = list(
        "string"
      ),
      NumberOfAssociatedQueues = 123,
      NumberOfAssociatedManualAssignmentQueues = 123,
      NumberOfAssociatedUsers = 123,
      AgentAvailabilityTimer = "TIME_SINCE_LAST_ACTIVITY"|"TIME_SINCE_LAST_INBOUND",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedRegion = "string",
      IsDefault = TRUE|FALSE,
      AssociatedQueueIds = list(
        "string"
      ),
      AssociatedManualAssignmentQueueIds = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  ApproximateTotalCount = 123
)

Request syntax

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