ListDevEnvironments
Retrieves a list of Dev Environments in a project.
Request Syntax
POST /v1/spaces/spaceName/devEnvironments HTTP/1.1
Content-type: application/json
{
"filters": [
{
"comparisonOperator": "string",
"key": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string",
"projectName": "string"
}URI Request Parameters
The request uses the following URI parameters.
- spaceName
-
The name of the space.
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*Required: Yes
Request Body
The request accepts the following data in JSON format.
- filters
-
Information about filters to apply to narrow the results returned in the list.
Type: Array of Filter objects
Required: No
- maxResults
-
The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a
NextTokenelement, which you can use to obtain additional results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- nextToken
-
A token returned from a call to this API to indicate the next batch of results to return, if any.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10000.
Required: No
- projectName
-
The name of the project in the space.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"items": [
{
"alias": "string",
"creatorId": "string",
"id": "string",
"ides": [
{
"name": "string",
"runtime": "string"
}
],
"inactivityTimeoutMinutes": number,
"instanceType": "string",
"lastUpdatedTime": "string",
"persistentStorage": {
"sizeInGiB": number
},
"projectName": "string",
"repositories": [
{
"branchName": "string",
"repositoryName": "string"
}
],
"spaceName": "string",
"status": "string",
"statusReason": "string",
"vpcConnectionName": "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.
- items
-
Information about the Dev Environments in a project.
Type: Array of DevEnvironmentSummary objects
- nextToken
-
A token returned from a call to this API to indicate the next batch of results to return, if any.
Type: String
Errors
- AccessDeniedException
-
The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
HTTP Status Code: 403
- ConflictException
-
The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
HTTP Status Code: 409
- ResourceNotFoundException
-
The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
