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

GetSegment

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.

segment

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.

segment

A structure that contains the complete information about the segment.

Type: Segment object

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

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

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