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

TestSegmentPattern

Important

End of support notice: On October 16, 2025, AWS will discontinue support for CloudWatch Evidently. After October 16, 2025, you will no longer be able to access the Evidently console or CloudWatch Evidently resources.

Use this operation to test a rules pattern that you plan to use to create an audience segment. For more information about segments, see CreateSegment.

Request Syntax


POST /test-segment-pattern HTTP/1.1
Content-type: application/json

{
   "pattern": "string",
   "payload": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

pattern

The pattern to test.

Type: String

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

Required: Yes

payload

A sample evaluationContext JSON block to test against the specified pattern.

Type: String

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "match": boolean
}

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.

match

Returns true if the pattern matches the payload.

Type: Boolean

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

ThrottlingException

The request was denied because of request throttling. Retry the request.

HTTP Status Code: 429

ValidationException

The value of a parameter in the request caused an error.

HTTP Status Code: 400