Search Data Tables

connect_search_data_tables

R Documentation

Searches for data tables based on the table's ID, name, and description¶

Description¶

Searches for data tables based on the table's ID, name, and description. In the future, this operation can support searching on attribute names and possibly primary values. Follows other search operations closely and supports both search criteria and filters.

Usage¶

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

Arguments¶

InstanceId

[required] The unique identifier for the Amazon Connect instance to search within.

NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

MaxResults

The maximum number of data tables to return in one page of results.

Optional filters to apply to the search results, such as tag-based filtering for attribute-based access control.

SearchCriteria

Search criteria including string conditions for matching table names, descriptions, or resource IDs. Supports STARTS_WITH, CONTAINS, and EXACT comparison types.

Value¶

A list with the following syntax:

list(
  DataTables = list(
    list(
      Name = "string",
      Id = "string",
      Arn = "string",
      TimeZone = "string",
      Description = "string",
      ValueLockLevel = "NONE"|"DATA_TABLE"|"PRIMARY_VALUE"|"ATTRIBUTE"|"VALUE",
      LockVersion = list(
        DataTable = "string",
        Attribute = "string",
        PrimaryValues = "string",
        Value = "string"
      ),
      Version = "string",
      VersionDescription = "string",
      Status = "PUBLISHED",
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedRegion = "string",
      Tags = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  ApproximateTotalCount = 123
)

Request syntax¶

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