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

ListSegments

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.

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.

maxResults

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.

nextToken

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.

nextToken

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: .*

segments

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

Type: Array of Segment 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

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