ListLaunches
Returns configuration details about all the launches in the specified project.
Request Syntax
GET /projects/project
/launches?maxResults=maxResults
&nextToken=nextToken
&status=status
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results to include in the response.
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
ListLaunches
operation.Length Constraints: Minimum length of 1. Maximum length of 8192.
Pattern:
.*
- project
-
The name or ARN of the project to return the launch list from.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
(^[a-zA-Z0-9._-]*$)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[a-zA-Z0-9._-]*)
Required: Yes
- status
-
Use this optional parameter to limit the returned results to only the launches with the status that you specify here.
Valid Values:
CREATED | UPDATING | RUNNING | COMPLETED | CANCELLED
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"launches": [
{
"arn": "string",
"createdTime": number,
"description": "string",
"execution": {
"endedTime": number,
"startedTime": number
},
"groups": [
{
"description": "string",
"featureVariations": {
"string" : "string"
},
"name": "string"
}
],
"lastUpdatedTime": number,
"metricMonitors": [
{
"metricDefinition": {
"entityIdKey": "string",
"eventPattern": "string",
"name": "string",
"unitLabel": "string",
"valueKey": "string"
}
}
],
"name": "string",
"project": "string",
"randomizationSalt": "string",
"scheduledSplitsDefinition": {
"steps": [
{
"groupWeights": {
"string" : number
},
"segmentOverrides": [
{
"evaluationOrder": number,
"segment": "string",
"weights": {
"string" : number
}
}
],
"startTime": number
}
]
},
"status": "string",
"statusReason": "string",
"tags": {
"string" : "string"
},
"type": "string"
}
],
"nextToken": "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.
- launches
-
An array of structures that contain the configuration details of the launches in the specified project.
Type: Array of Launch objects
- nextToken
-
The token to use in a subsequent
ListLaunches
operation to return the next set of results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 8192.
Pattern:
.*
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: