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

ListSegmentReferences

Use this operation to find which experiments or launches are using a specified segment.

Request Syntax


GET /segments/segment/references?maxResults=maxResults&nextToken=nextToken&type=type 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 100.

nextToken

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

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

Pattern: .*

segment

The ARN of the segment that you want to view 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

type

Specifies whether to return information about launches or experiments that use this segment.

Valid Values: EXPERIMENT | LAUNCH

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "referencedBy": [ 
      { 
         "arn": "string",
         "endTime": "string",
         "lastUpdatedOn": "string",
         "name": "string",
         "startTime": "string",
         "status": "string",
         "type": "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 ListSegmentReferences operation to return the next set of results.

Type: String

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

Pattern: .*

referencedBy

An array of structures, where each structure contains information about one experiment or launch that uses this segment.

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

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