Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SearchDataTables

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.

Request Syntax


POST /search-data-tables HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "DataTableSearchCriteria"
      ],
      "OrConditions": [ 
         "DataTableSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "AttributeFilter": { 
         "AndCondition": { 
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "OrConditions": [ 
            { 
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

InstanceId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

MaxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

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

Type: String

Required: No

SearchCriteria

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

Type: DataTableSearchCriteria object

Required: No

SearchFilter

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

Type: DataTableSearchFilter object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "DataTables": [ 
      { 
         "Arn": "string",
         "CreatedTime": number,
         "Description": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "LockVersion": { 
            "Attribute": "string",
            "DataTable": "string",
            "PrimaryValues": "string",
            "Value": "string"
         },
         "Name": "string",
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         },
         "TimeZone": "string",
         "ValueLockLevel": "string",
         "Version": "string",
         "VersionDescription": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApproximateTotalCount

The approximate number of data tables that matched the search criteria.

Type: Long

DataTables

An array of data tables matching the search criteria with the same structure as DescribeTable except Version, VersionDescription, and LockVersion are omitted.

Type: Array of DataTable objects

NextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429