Search Notifications

connect_search_notifications

R Documentation

Searches for notifications based on specified criteria and filters¶

Description¶

Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags.

Usage¶

connect_search_notifications(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 to retrieve the next page of results.

MaxResults

The maximum number of results to return per page. Valid range is 1-100.

Filters to apply to the search results, such as tag-based filters.

SearchCriteria

The search criteria to apply when searching for notifications. Supports filtering by notification ID and message content using comparison types such as STARTS_WITH, CONTAINS, and EXACT.

Value¶

A list with the following syntax:

list(
  Notifications = list(
    list(
      Id = "string",
      Arn = "string",
      InstanceId = "string",
      Content = list(
        "string"
      ),
      Priority = "URGENT"|"HIGH"|"LOW",
      Recipients = list(
        "string"
      ),
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      ExpiresAt = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedRegion = "string",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      Tags = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  ApproximateTotalCount = 123
)

Request syntax¶

svc$search_notifications(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123,
  SearchFilter = list(
    AttributeFilter = list(
      OrConditions = list(
        list(
          TagConditions = list(
            list(
              TagKey = "string",
              TagValue = "string"
            )
          )
        )
      ),
      AndCondition = list(
        TagConditions = 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"
    )
  )
)