GetSegment - CloudWatch Evidently


Returns information about the specified segment. Specify the segment you want to view by specifying its ARN.

Request Syntax

GET /segments/segment HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The ARN of the segment to return information for.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: (^[-a-zA-Z0-9._]*$)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:segment/[-a-zA-Z0-9._]*)

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "segment": { "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.


A structure that contains the complete information about the segment.

Type: Segment object


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 references a resource that does not exist.

HTTP Status Code: 404


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: