ListSegments - CloudWatch Evidently


Returns a list of audience segments that you have created in your account in this Region.

Request Syntax

GET /segments?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The maximum number of results to include in the response. If you omit this, the default of 50 is used.

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


The token to use when requesting the next set of results. You received this token from a previous ListSegments operation.

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

Pattern: .*

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "segments": [ { "arn": "string", "createdTime": number, "description": "string", "experimentCount": number, "lastUpdatedTime": number, "launchCount": number, "name": "string", "pattern": "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.


The token to use in a subsequent ListSegments operation to return the next set of results.

Type: String

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

Pattern: .*


An array of structures that contain information about the segments in this Region.

Type: Array of Segment objects


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


You do not have sufficient permissions to perform this action.

HTTP Status Code: 403


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

HTTP Status Code: 429


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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: