GetDevEnvironment
Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.
Request Syntax
GET /v1/spaces/spaceName/projects/projectName/devEnvironments/id HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- id
-
The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.
Pattern:
[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}Required: Yes
- projectName
-
The name of the project in the space.
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*Required: Yes
- 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 does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"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"
}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.
- alias
-
The user-specified alias for the Dev Environment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
- creatorId
-
The system-generated unique ID of the user who created the Dev Environment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- id
-
The system-generated unique ID of the Dev Environment.
Type: String
Pattern:
[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} - ides
-
Information about the integrated development environment (IDE) configured for the Dev Environment.
Type: Array of Ide objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
- inactivityTimeoutMinutes
-
The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1200.
- instanceType
-
The Amazon EC2 instace type to use for the Dev Environment.
Type: String
Valid Values:
dev.standard1.small | dev.standard1.medium | dev.standard1.large | dev.standard1.xlarge - lastUpdatedTime
-
The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
. Type: Timestamp
- persistentStorage
-
Information about the amount of storage allocated to the Dev Environment. By default, a Dev Environment is configured to have 16GB of persistent storage.
Type: PersistentStorage object
- 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]+)* - repositories
-
The source repository that contains the branch cloned into the Dev Environment.
Type: Array of DevEnvironmentRepositorySummary objects
- spaceName
-
The name of the space.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)* - status
-
The current status of the Dev Environment.
Type: String
Valid Values:
PENDING | RUNNING | STARTING | STOPPING | STOPPED | FAILED | DELETING | DELETED - statusReason
-
The reason for the status.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- vpcConnectionName
-
The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
[a-zA-Z0-9]+(?:[-_\.][a-zA-Z0-9]+)*
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:
