SearchNotifications
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.
Request Syntax
POST /search-notifications HTTP/1.1
Content-type: application/json
{
"InstanceId": "string",
"MaxResults": number,
"NextToken": "string",
"SearchCriteria": {
"AndConditions": [
"NotificationSearchCriteria"
],
"OrConditions": [
"NotificationSearchCriteria"
],
"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 identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- MaxResults
-
The maximum number of results to return per page. Valid range is 1-100.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.
Type: String
Required: No
- 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.
Type: NotificationSearchCriteria object
Required: No
- SearchFilter
-
Filters to apply to the search results, such as tag-based filters.
Type: NotificationSearchFilter object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ApproximateTotalCount": number,
"NextToken": "string",
"Notifications": [
{
"Arn": "string",
"Content": {
"string" : "string"
},
"CreatedAt": number,
"ExpiresAt": number,
"Id": "string",
"InstanceId": "string",
"LastModifiedRegion": "string",
"LastModifiedTime": number,
"Priority": "string",
"Recipients": [ "string" ],
"Tags": {
"string" : "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 total number of notifications matching the search criteria.
Type: Long
- NextToken
-
The token for the next set of results. If present, there are more results available.
Type: String
- Notifications
-
A list of notifications matching the search criteria.
Type: Array of NotificationSearchSummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
